Skip to content

Conversation

@h2ls
Copy link
Collaborator

@h2ls h2ls commented Mar 12, 2025

Link issues

fixes #5610
fixes #5609

Summary By Copilot

This pull request includes several changes to the BootstrapBlazor components, focusing on improving the code readability by translating comments from Chinese to English and adding new functionality to handle Shift + Enter key presses in the input components.

Key changes:

Functionality Enhancements:

Code Readability Improvements:

Regression?

  • Yes
  • No

Risk

  • High
  • Medium
  • Low

Verification

  • Manual (required)
  • Automated

Packaging changes reviewed?

  • Yes
  • No
  • N/A

☑️ Self Check before Merge

⚠️ Please check all items below before review. ⚠️

  • Doc is updated/provided or not needed
  • Demo is updated/provided or not needed
  • Merge the latest code from the main branch

…allback

- Add `hasNoModifiers` helper to check for Ctrl/Shift/Alt/Meta keys
- Update Enter key handling in `handleKeyUp` to ignore modifier combinations
- Retain existing Escape key logic
@sourcery-ai
Copy link
Contributor

sourcery-ai bot commented Mar 12, 2025

Reviewer's Guide by Sourcery

This pull request modifies the keyup event handler for the textarea component to ensure that the Enter key callback is only triggered when the Enter key is pressed alone, without any modifier keys (Ctrl, Shift, Alt, Meta). A new helper function hasNoModifiers was introduced to check for the absence of modifier keys.

Sequence diagram for Enter key press with and without modifiers

sequenceDiagram
    participant User
    participant textarea
    participant BootstrapInput.razor.js
    participant invoke

    User->>textarea: Presses Enter key (no modifiers)
    textarea-->>BootstrapInput.razor.js: keyup event
    BootstrapInput.razor.js->>BootstrapInput.razor.js: hasNoModifiers(e) == true
    BootstrapInput.razor.js->>invoke: invokeMethodAsync(enterCallbackMethod, el.value)
    invoke-->>textarea: Callback triggered

    User->>textarea: Presses Ctrl+Enter
    textarea-->>BootstrapInput.razor.js: keyup event
    BootstrapInput.razor.js->>BootstrapInput.razor.js: hasNoModifiers(e) == false
    BootstrapInput.razor.js-->>textarea: Callback not triggered
Loading

File-Level Changes

Change Details Files
Implemented a modifier key check to ensure the Enter key callback is triggered only when the Enter key is pressed without any modifier keys.
  • Added a hasNoModifiers helper function to detect if Ctrl, Shift, Alt, or Meta keys are pressed.
  • Modified the keyup event handler to include the modifier check before triggering the Enter key callback.
src/BootstrapBlazor/Components/Input/BootstrapInput.razor.js

Assessment against linked issues

Issue Objective Addressed Explanation
#5610 The Enter key callback should only fire when the Enter key is pressed alone (without Ctrl/Shift/Alt/Meta keys).

Possibly linked issues


Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!
  • Generate a plan of action for an issue: Comment @sourcery-ai plan on
    an issue to generate a plan of action for it.

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

@bb-auto
Copy link

bb-auto bot commented Mar 12, 2025

Thanks for your PR, @h2ls. Someone from the team will get assigned to your PR shortly and we'll get it reviewed.

@bb-auto bb-auto bot requested a review from ArgoZhang March 12, 2025 08:27
sourcery-ai[bot]
sourcery-ai bot previously approved these changes Mar 12, 2025
Copy link
Contributor

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hey @h2ls - I've reviewed your changes - here's some feedback:

Overall Comments:

  • Consider adding a comment to explain why hasNoModifiers is needed.
Here's what I looked at during the review
  • 🟢 General issues: all looks good
  • 🟢 Security: all looks good
  • 🟢 Testing: all looks good
  • 🟢 Complexity: all looks good
  • 🟢 Documentation: all looks good

Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

@h2ls h2ls changed the title fix(textarea): Ensure Enter key callback fires only when pressed alone fix(Textarea): Ensure Enter key callback fires only when pressed alone Mar 12, 2025
@codecov
Copy link

codecov bot commented Mar 12, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 100.00%. Comparing base (2cf8af4) to head (41cb909).
Report is 1 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff            @@
##              main     #5611   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files          649       649           
  Lines        29622     29622           
  Branches      4165      4165           
=========================================
  Hits         29622     29622           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@ArgoZhang ArgoZhang linked an issue Mar 13, 2025 that may be closed by this pull request
1 task
@h2ls
Copy link
Collaborator Author

h2ls commented Mar 13, 2025

@dotnet-policy-service agree

@h2ls
Copy link
Collaborator Author

h2ls commented Mar 13, 2025

@microsoft-github-policy-service agree

ArgoZhang
ArgoZhang previously approved these changes Mar 13, 2025
@bb-auto bb-auto bot assigned ArgoZhang and unassigned h2ls Mar 13, 2025
@bb-auto bb-auto bot added the bug Something isn't working label Mar 13, 2025
@bb-auto bb-auto bot added this to the v9.4.0 milestone Mar 13, 2025
@ArgoZhang ArgoZhang changed the title fix(Textarea): Ensure Enter key callback fires only when pressed alone fix(Textarea): adding new functionality to handle Shift + Enter Mar 13, 2025
@ArgoZhang
Copy link
Member

@sourcery-ai review

@ArgoZhang ArgoZhang merged commit 0bab5a6 into main Mar 13, 2025
6 checks passed
@ArgoZhang ArgoZhang deleted the lee/handleKeyUp branch March 13, 2025 01:47
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

bug Something isn't working

Projects

None yet

Development

Successfully merging this pull request may close these issues.

bug(textarea): Unexpected Enter Key Triggering with Modifier Keys bug(Textarea): OnEnterAsync 事件缺少是否按下 Shift 参数

3 participants